ugp.org.SerialX.Protocols

Class SerializationProtocol<T>

java.lang.Object

ugp.org.SerialX.Protocols.SerializationProtocol<T>

Type Parameters:

T - | Generic type of object to use protocol for.

Direct Known Subclasses:

AutoProtocol, EnumProtocol, ListProtocol, MapProtocol, ScopeProtocol, SelfSerializableProtocol, StringProtocol

public abstract class SerializationProtocol<T>
extends java.lang.Object

This object supposed to be use for serializing and unserializing objects in Java by turning them in to array of Objects that can be serialized by Serializer and also turn array of these objects back in to that very same Object!
Instance of SerializationProtocol should be registered into Serializer.PROTOCOL_REGISTRY in order to work, also only one instance of each SerializationProtocol should be used!
Note: Protocols should not be serializable in any way!

Since:

1.0.0

Author:

PETO

Constructor Summary

Constructors

Constructor and Description
SerializationProtocol()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Class<? extends T>	applicableFor()
boolean	equals(java.lang.Object obj)
boolean	isActive()
abstract java.lang.Object[]	serialize(T object)
void	setActive(boolean isActive)
java.lang.String	toString()
abstract T	unserialize(java.lang.Class<? extends T> objectClass, java.lang.Object... args)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SerializationProtocol

public SerializationProtocol()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

serialize

public abstract java.lang.Object[] serialize(T object)

Parameters:

object - | The object.

Returns:

Array of objects to serialize created from given object.

Since:

1.0.0

unserialize

public abstract T unserialize(java.lang.Class<? extends T> objectClass,
                              java.lang.Object... args)
                       throws java.lang.Exception

Parameters:

objectClass - | The class of object that should be created. This can be useful when object T has children classes with same constructors. You can use reflection to make protocol working also for these child classes!

args - | Args to create obj T from.

Returns:

New instance of object T created from args.

Throws:

java.lang.Exception - you can just pass exception to Serializer if you are not interested in handling it on your own.

Since:

1.0.0

applicableFor

public abstract java.lang.Class<? extends T> applicableFor()

Returns:

Class that can be serialized using this protocol. In other words it should return class of object T

Since:

1.0.0

isActive

public boolean isActive()

Returns:

True if this protocol is active. Only active protocols can be used!

Since:

1.0.0

setActive

public void setActive(boolean isActive)

Parameters:

isActive - | Set this on true to activate this protocol or set this on false to deactivate it so it will not be used. This can be useful for example when you want to force program to serialize java.io.Serializable object using classic java.io.Serializable. For example when you deactivate StringProtocol program will be forced to serialize all Strings via java.io.Serializable.

Since:

1.0.0